Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add border radius in tags #1116

Conversation

CarolinaCobo
Copy link
Contributor

@CarolinaCobo CarolinaCobo commented Oct 13, 2024

✨ Codu Pull Request 💻

Pull Request details

  • Based on feedback and discussed with @NiallJoeMaher. Adding border radius in the main page tagsl.

Associated Screenshots

  • IF YOU HAVE ANY SCREENSHOTS, INCLUDE THEM HERE. ( Welcome file extensions include gifs/png screenshots of your feature in action )
  • IF YOU HAVE NO SCREENSHOTS, ENTER 'None'

Copy link

vercel bot commented Oct 13, 2024

@CarolinaCobo is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 13, 2024

Walkthrough

The pull request introduces aesthetic modifications to several components within the application, primarily focusing on enhancing the visual presentation through the addition of rounded corners to various elements. The ArticlesPage, Home, ArticlePreview, and PopularTags components have all received updates to their styling without impacting their underlying functionality or logic. Additionally, a new Content component has been added to display a video alongside a sidebar, incorporating a feature flag check. The changes ensure a consistent visual theme across the components while maintaining their original data handling and rendering processes.

Changes

File Path Change Summary
app/(app)/articles/_client.tsx Updated ArticlesPage component to add rounded class to divs, images, and Link components.
app/(app)/page.tsx Updated Home component to add rounded class to a div displaying a writing challenge.
components/ArticlePreview/ArticlePreview.tsx Modified ArticlePreview component by removing border-l-4 and changing rounded-r to rounded.
components/PopularTags/PopularTags.tsx Updated PopularTags component to include rounded class for Link components in the tags.
app/(app)/courses/[slug]/[id]/_client.tsx Introduced new Content component to display a video and sidebar, with feature flag check.

Possibly related PRs

Poem

🐇 In a world where corners are sharp and square,
A sprinkle of roundness brings style and flair.
With divs and links dressed in rounded delight,
Our components now shine, oh what a sight!
So hop with joy, let the changes be known,
For every new style, our app has grown! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dde2239 and 2f28f95.

📒 Files selected for processing (1)
  • components/ArticlePreview/ArticlePreview.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/ArticlePreview/ArticlePreview.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
components/PopularTags/PopularTags.tsx (1)

24-24: LGTM! Consider using a consistent border-radius value.

The addition of the rounded class successfully implements the border-radius feature for tags, aligning with the PR objectives. This change enhances the visual presentation without affecting the component's functionality.

For better consistency across the application, consider using a specific border-radius value (e.g., rounded-md or rounded-lg) instead of the generic rounded class. This ensures that all tags have the same degree of roundness throughout the application.

app/(app)/articles/_client.tsx (3)

164-164: LGTM: Appropriate image styling

The addition of the rounded-t class to the challenge Image component enhances the visual appeal by rounding the top corners, which is consistent with common design patterns and the PR's objective.

For improved clarity, consider adding a comment explaining why only the top corners are rounded:

className="w-full rounded-t" // Rounds only top corners to match container styling

194-194: LGTM: Consistent tag styling

The addition of the rounded class to the popular topics Link components enhances the visual consistency of the UI and aligns with the PR's objective of adding border radius to tags.

Consider adding an aria-label to improve accessibility for screen readers:

aria-label={`View articles tagged with ${getCamelCaseFromLower(title)}`}

This would provide more context to users navigating with assistive technologies.


Line range hint 161-194: Overall: Consistent UI improvements with potential for refactoring

The changes in this file consistently apply rounded corners to various UI elements, improving the visual appeal and meeting the PR's objective. These modifications are purely aesthetic and don't introduce any functional changes or apparent issues.

Consider refactoring the rounded corner classes into a shared constant or utility function if they are used extensively throughout the application. This could improve maintainability and ensure consistency across the codebase. For example:

// In a utils file
export const ROUNDED_CLASSES = {
  full: 'rounded',
  top: 'rounded-t',
  // ... other variations as needed
};

// In your component
import { ROUNDED_CLASSES } from '@/utils/styleUtils';

// Usage
className={`... ${ROUNDED_CLASSES.full}`}

This approach would centralize these styling decisions and make future updates easier to manage.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d45d070 and 02edef0.

📒 Files selected for processing (4)
  • app/(app)/articles/_client.tsx (2 hunks)
  • app/(app)/page.tsx (1 hunks)
  • components/ArticlePreview/ArticlePreview.tsx (1 hunks)
  • components/PopularTags/PopularTags.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • app/(app)/page.tsx
  • components/ArticlePreview/ArticlePreview.tsx
🧰 Additional context used
🔇 Additional comments (1)
app/(app)/articles/_client.tsx (1)

161-161: LGTM: Consistent styling improvement

The addition of the rounded class to the writing challenge div enhances the visual consistency of the UI, aligning with the PR's objective of adding border radius to elements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (4)
app/(app)/courses/[slug]/[id]/_client.tsx (4)

1-6: Consider replacing mock data with actual API calls.

The component is currently using mock data (mockContentList, mockVideoSrc) imported from a local mock file. While this is acceptable for development or testing purposes, it's important to replace these with actual API calls or data fetching logic before deploying to production.

Would you like assistance in implementing actual data fetching for this component?


8-13: Approve feature flag check with a minor suggestion.

The feature flag check is well-implemented, providing controlled access to the new feature. However, consider adding a type annotation to the flagEnabled variable for improved type safety:

const flagEnabled: boolean = isFlagEnabled(FEATURE_FLAGS.COURSE_VIDEO);

This change will make the code more robust and self-documenting.


15-27: Approve overall structure with a suggestion for video URL.

The component structure and layout are well-organized using Tailwind CSS classes. However, the YouTube video URL is hardcoded, which might not be flexible for different course videos.

Consider passing the video URL as a prop or fetching it from your course data:

interface ContentProps {
  session: Session | null;
  videoUrl: string;
}

const Content = ({ session, videoUrl }: ContentProps) => {
  // ...

  <iframe
    className="aspect-video w-full"
    src={videoUrl}
    title="Course video"
  ></iframe>

  // ...
};

This change will make the component more reusable and easier to update with different video content.


30-60: Approve sidebar content rendering with accessibility suggestion.

The sidebar content rendering is well-implemented with proper conditional rendering and key usage. To improve accessibility, consider adding an aria-label to the list and using more semantic HTML:

- <ul className="divide-y divide-gray-700">
+ <ul className="divide-y divide-gray-700" aria-label="Course content">
  {mockContentList && mockContentList.length > 0 ? (
    mockContentList.map((item, index) => (
-     <li key={index} className="flex flex-row items-center justify-between px-2 py-2">
+     <li key={index} className="flex flex-row items-center justify-between px-2 py-2">
+       <div className="flex flex-row items-center">
+         <SquarePlay className="mr-4 h-5 w-5 text-white group-hover:text-white" aria-hidden="true" />
+         <span>{item.title}</span>
+       </div>
        <CircleCheck
          className={item.watched ? "mr-2 h-5 w-5 text-pink-600" : "mr-2 h-5 w-5 text-white"}
-         aria-hidden="true"
+         aria-label={item.watched ? "Watched" : "Not watched"}
        />
      </li>
    ))
  ) : (
-   <li className="text-center text-gray-500">No content available</li>
+   <li className="text-center text-gray-500" aria-live="polite">No content available</li>
  )}
</ul>

These changes will improve the screen reader experience and overall accessibility of the component.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 02edef0 and 6433f7d.

📒 Files selected for processing (3)
  • app/(app)/courses/[slug]/[id]/_client.tsx (1 hunks)
  • app/(app)/page.tsx (1 hunks)
  • components/ArticlePreview/ArticlePreview.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • app/(app)/page.tsx
  • components/ArticlePreview/ArticlePreview.tsx
🧰 Additional context used

Comment on lines 63 to 66
<div className="flex-none">
<div>Video title</div>
<div>descritpion</div>
</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

⚠️ Potential issue

Improve video information section.

The video information section is currently using placeholder text. Consider the following improvements:

  1. Use dynamic content for the title and description, possibly from the same source as the video URL.
  2. Fix the typo in "descritpion" to "description".
  3. Add appropriate semantic HTML and styling for better structure and readability.

Here's a suggested improvement:

<div className="mt-4 p-4">
  <h2 className="text-xl font-bold">{videoTitle}</h2>
  <p className="mt-2 text-gray-300">{videoDescription}</p>
</div>

Replace videoTitle and videoDescription with the actual data from your course content.

NiallJoeMaher
NiallJoeMaher previously approved these changes Oct 15, 2024
Copy link
Contributor

@NiallJoeMaher NiallJoeMaher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌮 🦖 LGTM!

Copy link

vercel bot commented Oct 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codu ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 16, 2024 9:13pm

@NiallJoeMaher NiallJoeMaher merged commit 2dc9bb8 into codu-code:develop Oct 16, 2024
6 checks passed
@NiallJoeMaher NiallJoeMaher linked an issue Oct 17, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tags in home page not matching style
2 participants